CCMAIL - VBX (VIM Implementations) DATE: October 27, 1994 Release Version: 2.0 Author: Jower Garcia Toppin Telephone Number: (582)-9611282 Compuserve: 73000,1661 Internet: 91-22701 RELEASE INFORMATION This Module constitute the 2nd release of CCVBX (CCMAIL VBX implementation). CCVBX was designed to be used with BORLAND C++,VISUAL C++ & VISUAL BASIC. CCVBX implements a vast number of the VIM functions that LOTUS distribute with their products. With CCVBX you will be able to design programs that work along with CCMAIL, CCFAX and other LOTUS software. We are NOT responsible for the problems you can have for using this VBX but we will help you at any time. The CCVBX you get from COMPUSERVE is a DEMONSTRATION version that you can use with your DEMO programs. You will have to pay the LOTUS royalties for using the message system they implements with their products. The FULL version of CCVBX can be obtained by COMPUSERVE: 73000,1661. CCVBX 2.0 $25 CCVBX 2.0 & Source Code $100 What you need to use CCVBX? You will need CC-MAIL installed in your network in order to use CCVBX. You will also need to install the "Client Workstations" in all workstations that will use CCVBX. Contact LOTUS representants for more information. --------------------------------------------------------------------------------------- CCVBX IMPLEMENTATION CCVBX consist in two custom controls: The CCMAIL Control Class, The CCMSG Control Class, These controls are all you need to control an Address in CCMAIL. With CCVBX controls you will be able to: - Receive Message that are in your INBOX - Move a Message to any Folder or Category in CCMAIL implementation - Automatic or Manual LOGIN - Change the user at any moment - Get the number of message waiting in your Inbox - Get Information about the user in your Post Office - Get Information about your Post Office - Look for Address in the Post Office - Get Global Information about a message (Subject, From, Number of Attachment) - Get information about an attachment (Type, size, path, name, class, etc.) - Save an Attachment or The Complete message in a Disk File - Get an Attachment in a Memory location - Delete, Create, Send and reply any message in any folder --------------------------------------------------------------------------------------- THE CCMAIL CONTROL CLASS The CCmail class control all the global information about cc-mail. You will use it to login in CCMAIL and get general information about the message in your inbox or any other folder; you will also use these control to get information about any other user in you post office. The CCMAIL Class will help you to open 1 or more session to any post office available in your network, so you will transfer message or information between them. By the other hand, the CCmsg class is intended to get information about a message in any CCMAIL folder. Properties of CCMAIL CLASS: * About: (Design time only). This Property will inform you about the original programmer of CCVBX * Session: (Run Time only). VIM Session assigned by CCMAIL. GET PROPERTY: Session&=CCMail.Session return 0 if NO Session has been established Any other number indicate the Session Handle SET PROPERTY CCmail.Session=0 (ZERO) the Session that was opened is close. CCmail.Session=1 Login a User in the CCMAIL Post Office * Container: (Run Time Only). Vim Container assigned by CCMAIL GET PROPERTY: Container&=CCMail.Container return 0 if the Message Container is Closed Any other number is the Handle of the Message Container SET PROPERTY CCmail.Container=0 (ZERO) the Container that was opened is close. * ccMail_Login: (Design Time Only). Indicate if CCVBX automatically login when application starts. Values: 0 = Auto-Login 1 = Manual - Login * UnreadMsgRef: (Run Time Only). Return a Message Reference of an Unread e-mail. If there is not any Unread message it will return "NONE" szMsgRef$=CCmail.UnreadMsgRef Return: NONE if UNREAD message is not found in current folder any other string if an unread message is available in the current folder * NewMessage:(Run Time Only). Query the INBOX for new message in the current address. bNewMessage%=CCmail.NewMessage Return: 0 if there is NOT a new message 1 if a new message is found in your INBOX * NumMsgInFolder: (Run Time Only). Return the number of message in the current folder. Query Type: 0 All Messages 1 Read Messages 2 Unread Messages CCmail.NumMsgInFolder=QueryType& NumMsgFound&=CCmail.NumMsgInFolder Return 0 if NO message has been found in your current folder n Number of messages found in the current folder * GetMsgNum: (Run Time Only). Indicate or change the actual message number CCmail.GetMsgNum=NewMsgNum& Change the Message pointer in your current folder ActualMsgNum&=CCmail.GetMsgNum return 0 if no message is been pointed by CCMAIL control class n Number of the message been pointed * MsgRefNum: (Run Time Only). Return the message reference of the current message. szMsgRef$=CCmail.MsgRefNum * MsgStatus: (Run Time Only). Return the Status of the current Message. msgStatus&=CCmail.MsgStatus Return: 1 if message has been read 2 if message has not need read * ScanFolder: (Design and Runtime). Change the current Folder CCmail.ScanFolder=NewFolder$ CurrentFolder$=CCmail.ScanFolder return the name of the current folder * Password: (Design and Runtime). Indicate the password to be use for CCMAIL login CCmail.Password=NewLoginPassword$ ActualPassword$=CCmail.Password * Subject: (Run Time Only). Return the Subject of the Current Message * From: (Run Time Only). Return the From Address of the Current Message * MsgDate: (Run Time Only). Return MSG Date of the Current Message * MsgID: (Run Time Only). Return the Unique Message ID * User: (Design and Runtime). Indicate the User of CCMAIL CCmail.User=NewLoginUser$ ActualUser$=CCmail.User * nBooks: (Run Time Only). Return the number of Address Books available in the post office: NumberOfBooks&=CCmail.nBooks * GetBook: (Run Time Only). Set and Return the current Book. CCmail.GetBook=ChangeBook& Set the new Book ActualBookNumber&=CCmail.GetBook * BookName: (Run Time Only). Return the Name of the Current Book CurrentBookName$=CCmail.BookName * nAddress: (Run Time Only). Return the number of address available in the current book NumOfAddress&=CCmail.nAddress * GetAddress: (Run Time Only). Set and Return the current address number CCmail.GetAddress=ChangeAddress& ActualAddressNumber&=CCmail.GetAddress * AddressName: (Run Time Only). Return the Address Name of the current Address AddressName$=CCmail.AddressName ---------------------------------------------------------------------------------------------- The CCMSG Control Class, The CCmsg Control class is used to obtain information about: - Message in the INBOX or any other Folder - Message that has been extracted (Save in DISK) - New Message that are composed You can also handle the attachments that are included with your message. With CCMSG you will be able to: - Obtain Information about a e-mail message - Reply a message that are in your inbox - Extract a message - Create and Send a New Message - Obtain All the attachment information (Size, Class, Type, etc.) - Save any attachment on disk or retrieve it on memory - Delete a Message - Move or Remove the message to any Folder Properties of CCMSG: * About: (Design time only). This Property will inform you about the original programmer of CCVBX * Session: (Run Time only). Set the VIM Session assigned by CCMAIL. Session&=CCMsg.Session return: 0 if NO Session has been assigned Any other number indicate the Session Handle CCmsg.Session=CCmail.Session Indicate the session obtained from the CCmail Control Class * Container: (Run Time Only). Set Vim Container assigned by CCMAIL Container&=CCMsg.Container Return the Handle of the Message Container CCmsg.Container=CCmail.Container Set the Container that was Obtained from the CCmail Control Class. * MsgRef: (Run Time Only). Set The Message Reference of the message you want to READ CCmsg.MsgRef=SetMsgRef$ * MsgDate: (Run Time Only). Return the Date of the current Message. VimDate&=CCmsg.MsgDate * SendTo: (Run Time Only) Set the recipient for the message that will be replied. CCmsg.SendTo=NewAddress$ (i.e. CCmsg.SendTo="Toppin, Jower") * SalvarMsgAEnviar: (Run Time Only). Indicate if the message that is going to be sent will be saved or not. CCMsg.SalvarMsgAEnviar=True (Save The Message) CCMsg.SalvarMsgAEnviar=False (DON'T Save The Message) * RemitirMsg: (Run Time Only). Reply the current message to the address indicated by SendTo. CCmsg.RemitirMsg=0 * Subject: (Run Time Only). Indicate the Subject of the Current Message: Subject$=CCmsg.Subject Set the New Subject for the New Message or Message been replied CCmsg.Subject=NewSubject$ * From: (Run Time Only). Indicate the address originator of the current message * BorrarMsg: (Run Time Only). Delete the current Message from the INBOX CCmsg.BorrarMsg=0 * nItems: (Run Time Only). Indicate the number of items of the current message NumberOfItems&=CCmsg.nItems * MoverToCategoria: (Run Time Only). Move the current Message to the indicated folder. CCmsg.MoverToCategoria=MoveToFolder$ * RemoverFromCategoria: (Run Time Only). Remove the current message from the indicated folder. CCmsg.RemoverFromCategoria=RemoveFromFolder$ * SetItemName: (Run Time Only). Set a New Name for any attachment CCmsg.SetItemName=NewAttachmentName$ * GetItemNumOnDisk: (Run Time Only). Save the attachment number in the file indicated by the SetItemName Property. CCmsg.GetItemNumOnDisk=NumMsg& * GetItemNumOnMemory: (Run Time Only). Retrieve the attachment number in the global heap memory. CCmsg.GetItemNumOnMemory=NumMsg& MemoryHandle&=CCmsg.GetItemNumOnMemory * QueryItemNum: (Run Time Only) Retrieve information about the attachment indicated. CCmsg.QueryItemNum=NumMsgToQuery& * ItemClass: (Run Time Only). Get the item class of the current attachment AttachClass&=CCmsg.ItemClass return: 4 VIMSEL_APP_DEFINED 6 VIMSEL_ATTACH 56 VIMSEL_NESTED_MSG 62 VIMSEL_NOTE_PART * ItemType (Run Time Only). Retrieve the type of the attachment AttachType$=CCmsg.ItemType return VIM_TEXT Simple, unstyled text VIM_UNWRAPPED_TEXT Unwrapped, unstyled text VIM_RTF Microsoft rich text VIM_STYLED Macintosh styled text VIM_FAX PCX format FAX image VIM_PICT Macintosh picture VIM_MOVIE QuickTime sound and Video VIM_IMAG Macintosh FAX image part * ItemSize (Run Time Only). Retrieve the size of the current attachment AttachSize&=CCmsg.ItemSize * OriginalItemName (Run Time Only). Retrieve the Name of the attachment ItemName$=CCmsg.OriginalItemName * ExtraerMsg: (Run Time Only). Extract the current message to the file indicated. CCmsg.ExtraerMsg=FileName$ * AbrirExtractedMsg: (Run Time Only) Open the extracted message indicated CCmsg.AbrirExtractedMsg=FileName$ * CreateNewMsg: (Run Time Only). Create a new message to be send CCmsg.CreateNewMsg=0 * SetAttach: (Run Time Only). Add an attachment to the current message been composed. CCmsg.SetAttach=AttachmentFileName$ * SendNewMsg: (Run Time Only). Send The New Message to the address indicated by the SendTo Property. CCmsg.SendNewMsg=0 * CerrarMsg: (Run Time Only). Close a message that has been open (extracted) or created (New message that don`t want to be send. * TipoDeMensaje: (Run Time Only). Indicate the actual message been handled by the control. MessageType&=CCmsg.TipoDeMensaje return: 0 the message is the INBOX or AnyFolder 1 the message is a NEW message been composed 2 the message is an extracted message